import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetEBSVolumeRecommendationsRequest, GetEBSVolumeRecommendationsResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link GetEBSVolumeRecommendationsCommand}. */ export interface GetEBSVolumeRecommendationsCommandInput extends GetEBSVolumeRecommendationsRequest { } /** * @public * * The output of {@link GetEBSVolumeRecommendationsCommand}. */ export interface GetEBSVolumeRecommendationsCommandOutput extends GetEBSVolumeRecommendationsResponse, __MetadataBearer { } declare const GetEBSVolumeRecommendationsCommand_base: { new (input: GetEBSVolumeRecommendationsCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [GetEBSVolumeRecommendationsCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.

*

Compute Optimizer generates recommendations for Amazon EBS volumes that * meet a specific set of requirements. For more information, see the Supported * resources and requirements in the Compute Optimizer User * Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ComputeOptimizerClient, GetEBSVolumeRecommendationsCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import * // const { ComputeOptimizerClient, GetEBSVolumeRecommendationsCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import * // import type { ComputeOptimizerClientConfig } from "@aws-sdk/client-compute-optimizer"; * const config = {}; // type is ComputeOptimizerClientConfig * const client = new ComputeOptimizerClient(config); * const input = { // GetEBSVolumeRecommendationsRequest * volumeArns: [ // VolumeArns * "STRING_VALUE", * ], * nextToken: "STRING_VALUE", * maxResults: Number("int"), * filters: [ // EBSFilters * { // EBSFilter * name: "Finding", * values: [ // FilterValues * "STRING_VALUE", * ], * }, * ], * accountIds: [ // AccountIds * "STRING_VALUE", * ], * }; * const command = new GetEBSVolumeRecommendationsCommand(input); * const response = await client.send(command); * // { // GetEBSVolumeRecommendationsResponse * // nextToken: "STRING_VALUE", * // volumeRecommendations: [ // VolumeRecommendations * // { // VolumeRecommendation * // volumeArn: "STRING_VALUE", * // accountId: "STRING_VALUE", * // currentConfiguration: { // VolumeConfiguration * // volumeType: "STRING_VALUE", * // volumeSize: Number("int"), * // volumeBaselineIOPS: Number("int"), * // volumeBurstIOPS: Number("int"), * // volumeBaselineThroughput: Number("int"), * // volumeBurstThroughput: Number("int"), * // rootVolume: true || false, * // }, * // finding: "Optimized" || "NotOptimized", * // utilizationMetrics: [ // EBSUtilizationMetrics * // { // EBSUtilizationMetric * // name: "VolumeReadOpsPerSecond" || "VolumeWriteOpsPerSecond" || "VolumeReadBytesPerSecond" || "VolumeWriteBytesPerSecond" || "VolumeIOPSExceeded" || "VolumeThroughputExceeded", * // statistic: "Maximum" || "Average", * // value: Number("double"), * // }, * // ], * // lookBackPeriodInDays: Number("double"), * // volumeRecommendationOptions: [ // VolumeRecommendationOptions * // { // VolumeRecommendationOption * // configuration: { * // volumeType: "STRING_VALUE", * // volumeSize: Number("int"), * // volumeBaselineIOPS: Number("int"), * // volumeBurstIOPS: Number("int"), * // volumeBaselineThroughput: Number("int"), * // volumeBurstThroughput: Number("int"), * // rootVolume: true || false, * // }, * // performanceRisk: Number("double"), * // rank: Number("int"), * // savingsOpportunity: { // SavingsOpportunity * // savingsOpportunityPercentage: Number("double"), * // estimatedMonthlySavings: { // EstimatedMonthlySavings * // currency: "USD" || "CNY", * // value: Number("double"), * // }, * // }, * // savingsOpportunityAfterDiscounts: { // EBSSavingsOpportunityAfterDiscounts * // savingsOpportunityPercentage: Number("double"), * // estimatedMonthlySavings: { // EBSEstimatedMonthlySavings * // currency: "USD" || "CNY", * // value: Number("double"), * // }, * // }, * // }, * // ], * // lastRefreshTimestamp: new Date("TIMESTAMP"), * // currentPerformanceRisk: "VeryLow" || "Low" || "Medium" || "High", * // effectiveRecommendationPreferences: { // EBSEffectiveRecommendationPreferences * // savingsEstimationMode: { // EBSSavingsEstimationMode * // source: "PublicPricing" || "CostExplorerRightsizing" || "CostOptimizationHub", * // }, * // lookBackPeriod: "DAYS_14" || "DAYS_32" || "DAYS_93", * // }, * // tags: [ // Tags * // { // Tag * // key: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // ], * // }, * // ], * // errors: [ // GetRecommendationErrors * // { // GetRecommendationError * // identifier: "STRING_VALUE", * // code: "STRING_VALUE", * // message: "STRING_VALUE", * // }, * // ], * // }; * * ``` * * @param GetEBSVolumeRecommendationsCommandInput - {@link GetEBSVolumeRecommendationsCommandInput} * @returns {@link GetEBSVolumeRecommendationsCommandOutput} * @see {@link GetEBSVolumeRecommendationsCommandInput} for command's `input` shape. * @see {@link GetEBSVolumeRecommendationsCommandOutput} for command's `response` shape. * @see {@link ComputeOptimizerClientResolvedConfig | config} for ComputeOptimizerClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You do not have sufficient access to perform this action.

* * @throws {@link InternalServerException} (server fault) *

An internal error has occurred. Try your call again.

* * @throws {@link InvalidParameterValueException} (client fault) *

The value supplied for the input parameter is out of range or not valid.

* * @throws {@link MissingAuthenticationToken} (client fault) *

The request must contain either a valid (registered) Amazon Web Services access key ID * or X.509 certificate.

* * @throws {@link OptInRequiredException} (client fault) *

The account is not opted in to Compute Optimizer.

* * @throws {@link ResourceNotFoundException} (client fault) *

A resource that is required for the action doesn't exist.

* * @throws {@link ServiceUnavailableException} (server fault) *

The request has failed due to a temporary failure of the server.

* * @throws {@link ThrottlingException} (client fault) *

The request was denied due to request throttling.

* * @throws {@link ComputeOptimizerServiceException} *

Base exception class for all service exceptions from ComputeOptimizer service.

* * * @public */ export declare class GetEBSVolumeRecommendationsCommand extends GetEBSVolumeRecommendationsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetEBSVolumeRecommendationsRequest; output: GetEBSVolumeRecommendationsResponse; }; sdk: { input: GetEBSVolumeRecommendationsCommandInput; output: GetEBSVolumeRecommendationsCommandOutput; }; }; }