« blib/lib/Paws/ComputeOptimizer/ExportDestination.pm
↑ Summary
blib/lib/Paws/ComputeOptimizer/ExportEBSVolumeRecommendationsResponse.pm »
| 1 | |||
| 2 | package Paws::ComputeOptimizer::ExportEBSVolumeRecommendations; | ||
| 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::EBSFilter]', 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 => 'ExportEBSVolumeRecommendations'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ComputeOptimizer::ExportEBSVolumeRecommendationsResponse'); | ||
| 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::ExportEBSVolumeRecommendations - Arguments for method ExportEBSVolumeRecommendations on L<Paws::ComputeOptimizer> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ExportEBSVolumeRecommendations on the | ||
| 27 | L<AWS Compute Optimizer|Paws::ComputeOptimizer> service. Use the attributes of this class | ||
| 28 | as arguments to method ExportEBSVolumeRecommendations. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ExportEBSVolumeRecommendations. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $compute-optimizer = Paws->service('ComputeOptimizer'); | ||
| 35 | my $ExportEBSVolumeRecommendationsResponse = | ||
| 36 | $compute -optimizer->ExportEBSVolumeRecommendations( | ||
| 37 | S3DestinationConfig => { | ||
| 38 | Bucket => 'MyDestinationBucket', # OPTIONAL | ||
| 39 | KeyPrefix => 'MyDestinationKeyPrefix', # OPTIONAL | ||
| 40 | }, | ||
| 41 | AccountIds => [ 'MyAccountId', ... ], # OPTIONAL | ||
| 42 | FieldsToExport => [ | ||
| 43 | 'AccountId', | ||
| 44 | ... # values: AccountId, VolumeArn, Finding, UtilizationMetricsVolumeReadOpsPerSecondMaximum, UtilizationMetricsVolumeWriteOpsPerSecondMaximum, UtilizationMetricsVolumeReadBytesPerSecondMaximum, UtilizationMetricsVolumeWriteBytesPerSecondMaximum, LookbackPeriodInDays, CurrentConfigurationVolumeType, CurrentConfigurationVolumeBaselineIOPS, CurrentConfigurationVolumeBaselineThroughput, CurrentConfigurationVolumeBurstIOPS, CurrentConfigurationVolumeBurstThroughput, CurrentConfigurationVolumeSize, CurrentMonthlyPrice, RecommendationOptionsConfigurationVolumeType, RecommendationOptionsConfigurationVolumeBaselineIOPS, RecommendationOptionsConfigurationVolumeBaselineThroughput, RecommendationOptionsConfigurationVolumeBurstIOPS, RecommendationOptionsConfigurationVolumeBurstThroughput, RecommendationOptionsConfigurationVolumeSize, RecommendationOptionsMonthlyPrice, RecommendationOptionsPerformanceRisk, LastRefreshTimestamp | ||
| 45 | ], # OPTIONAL | ||
| 46 | FileFormat => 'Csv', # OPTIONAL | ||
| 47 | Filters => [ | ||
| 48 | { | ||
| 49 | Name => 'Finding', # values: Finding; OPTIONAL | ||
| 50 | Values => [ 'MyFilterValue', ... ], # OPTIONAL | ||
| 51 | }, | ||
| 52 | ... | ||
| 53 | ], # OPTIONAL | ||
| 54 | IncludeMemberAccounts => 1, # OPTIONAL | ||
| 55 | ); | ||
| 56 | |||
| 57 | # Results: | ||
| 58 | my $JobId = $ExportEBSVolumeRecommendationsResponse->JobId; | ||
| 59 | my $S3Destination = $ExportEBSVolumeRecommendationsResponse->S3Destination; | ||
| 60 | |||
| 61 | # Returns a L<Paws::ComputeOptimizer::ExportEBSVolumeRecommendationsResponse> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer/ExportEBSVolumeRecommendations> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 AccountIds => ArrayRef[Str|Undef] | ||
| 70 | |||
| 71 | The IDs of the AWS accounts for which to export Amazon EBS volume | ||
| 72 | recommendations. | ||
| 73 | |||
| 74 | If your account is the management account of an organization, use this | ||
| 75 | parameter to specify the member account for which you want to export | ||
| 76 | recommendations. | ||
| 77 | |||
| 78 | This parameter cannot be specified together with the include member | ||
| 79 | accounts parameter. The parameters are mutually exclusive. | ||
| 80 | |||
| 81 | Recommendations for member accounts are not included in the export if | ||
| 82 | this parameter, or the include member accounts parameter, is omitted. | ||
| 83 | |||
| 84 | You can specify multiple account IDs per request. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 FieldsToExport => ArrayRef[Str|Undef] | ||
| 89 | |||
| 90 | The recommendations data to include in the export file. For more | ||
| 91 | information about the fields that can be exported, see Exported files | ||
| 92 | (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files) | ||
| 93 | in the I<Compute Optimizer User Guide>. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 FileFormat => Str | ||
| 98 | |||
| 99 | The format of the export file. | ||
| 100 | |||
| 101 | The only export file format currently supported is C<Csv>. | ||
| 102 | |||
| 103 | Valid values are: C<"Csv"> | ||
| 104 | |||
| 105 | =head2 Filters => ArrayRef[L<Paws::ComputeOptimizer::EBSFilter>] | ||
| 106 | |||
| 107 | An array of objects that describe a filter to export a more specific | ||
| 108 | set of Amazon EBS volume recommendations. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 IncludeMemberAccounts => Bool | ||
| 113 | |||
| 114 | Indicates whether to include recommendations for resources in all | ||
| 115 | member accounts of the organization if your account is the management | ||
| 116 | account of an organization. | ||
| 117 | |||
| 118 | The member accounts must also be opted in to Compute Optimizer, and | ||
| 119 | trusted access for Compute Optimizer must be enabled in the | ||
| 120 | organization account. For more information, see Compute Optimizer and | ||
| 121 | AWS Organizations trusted access | ||
| 122 | (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access) | ||
| 123 | in the I<AWS Compute Optimizer User Guide>. | ||
| 124 | |||
| 125 | Recommendations for member accounts of the organization are not | ||
| 126 | included in the export file if this parameter is omitted. | ||
| 127 | |||
| 128 | This parameter cannot be specified together with the account IDs | ||
| 129 | parameter. The parameters are mutually exclusive. | ||
| 130 | |||
| 131 | Recommendations for member accounts are not included in the export if | ||
| 132 | this parameter, or the account IDs parameter, is omitted. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 B<REQUIRED> S3DestinationConfig => L<Paws::ComputeOptimizer::S3DestinationConfig> | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head1 SEE ALSO | ||
| 144 | |||
| 145 | This class forms part of L<Paws>, documenting arguments for method ExportEBSVolumeRecommendations in L<Paws::ComputeOptimizer> | ||
| 146 | |||
| 147 | =head1 BUGS and CONTRIBUTIONS | ||
| 148 | |||
| 149 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 150 | |||
| 151 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 152 | |||
| 153 | =cut | ||
| 154 |