import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeBandwidthRateLimitInput, DescribeBandwidthRateLimitOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeBandwidthRateLimitCommand}. */ export interface DescribeBandwidthRateLimitCommandInput extends DescribeBandwidthRateLimitInput { } /** * @public * * The output of {@link DescribeBandwidthRateLimitCommand}. */ export interface DescribeBandwidthRateLimitCommandOutput extends DescribeBandwidthRateLimitOutput, __MetadataBearer { } declare const DescribeBandwidthRateLimitCommand_base: { new (input: DescribeBandwidthRateLimitCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeBandwidthRateLimitCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns the bandwidth rate limits of a gateway. By default, these limits are not set, * which means no bandwidth rate limiting is in effect. This operation is supported only for * the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits * for S3 file gateways, use DescribeBandwidthRateLimitSchedule.

*

This operation returns a value for a bandwidth rate limit only if the limit is set. If * no limits are set for the gateway, then this operation returns only the gateway ARN in the * response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of * the gateway in your request.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { StorageGatewayClient, DescribeBandwidthRateLimitCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import * // const { StorageGatewayClient, DescribeBandwidthRateLimitCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import * // import type { StorageGatewayClientConfig } from "@aws-sdk/client-storage-gateway"; * const config = {}; // type is StorageGatewayClientConfig * const client = new StorageGatewayClient(config); * const input = { // DescribeBandwidthRateLimitInput * GatewayARN: "STRING_VALUE", // required * }; * const command = new DescribeBandwidthRateLimitCommand(input); * const response = await client.send(command); * // { // DescribeBandwidthRateLimitOutput * // GatewayARN: "STRING_VALUE", * // AverageUploadRateLimitInBitsPerSec: Number("long"), * // AverageDownloadRateLimitInBitsPerSec: Number("long"), * // }; * * ``` * * @param DescribeBandwidthRateLimitCommandInput - {@link DescribeBandwidthRateLimitCommandInput} * @returns {@link DescribeBandwidthRateLimitCommandOutput} * @see {@link DescribeBandwidthRateLimitCommandInput} for command's `input` shape. * @see {@link DescribeBandwidthRateLimitCommandOutput} for command's `response` shape. * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape. * * @throws {@link InternalServerError} (server fault) *

An internal server error has occurred during the request. For more information, see the * error and message fields.

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

An exception occurred because an invalid gateway request was issued to the service. For * more information, see the error and message fields.

* * @throws {@link StorageGatewayServiceException} *

Base exception class for all service exceptions from StorageGateway service.

* * * @example To describe the bandwidth rate limits of a gateway * ```javascript * // Returns a value for a bandwidth rate limit if set. If not set, then only the gateway ARN is returned. * const input = { * GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" * }; * const command = new DescribeBandwidthRateLimitCommand(input); * const response = await client.send(command); * /* response is * { * AverageDownloadRateLimitInBitsPerSec: 204800, * AverageUploadRateLimitInBitsPerSec: 102400, * GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" * } * *\/ * ``` * * @public */ export declare class DescribeBandwidthRateLimitCommand extends DescribeBandwidthRateLimitCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeBandwidthRateLimitInput; output: DescribeBandwidthRateLimitOutput; }; sdk: { input: DescribeBandwidthRateLimitCommandInput; output: DescribeBandwidthRateLimitCommandOutput; }; }; }