import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient"; import type { GetBucketMetricDataRequest, GetBucketMetricDataResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetBucketMetricDataCommand}. */ export interface GetBucketMetricDataCommandInput extends GetBucketMetricDataRequest { } /** * @public * * The output of {@link GetBucketMetricDataCommand}. */ export interface GetBucketMetricDataCommandOutput extends GetBucketMetricDataResult, __MetadataBearer { } declare const GetBucketMetricDataCommand_base: { new (input: GetBucketMetricDataCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: GetBucketMetricDataCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Returns the data points of a specific metric for an Amazon Lightsail bucket.

*

Metrics report the utilization of a bucket. View and collect metric data regularly to * monitor the number of objects stored in a bucket (including object versions) and the storage * space used by those objects.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { LightsailClient, GetBucketMetricDataCommand } from "@aws-sdk/client-lightsail"; // ES Modules import * // const { LightsailClient, GetBucketMetricDataCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import * // import type { LightsailClientConfig } from "@aws-sdk/client-lightsail"; * const config = {}; // type is LightsailClientConfig * const client = new LightsailClient(config); * const input = { // GetBucketMetricDataRequest * bucketName: "STRING_VALUE", // required * metricName: "BucketSizeBytes" || "NumberOfObjects", // required * startTime: new Date("TIMESTAMP"), // required * endTime: new Date("TIMESTAMP"), // required * period: Number("int"), // required * statistics: [ // MetricStatisticList // required * "Minimum" || "Maximum" || "Sum" || "Average" || "SampleCount", * ], * unit: "Seconds" || "Microseconds" || "Milliseconds" || "Bytes" || "Kilobytes" || "Megabytes" || "Gigabytes" || "Terabytes" || "Bits" || "Kilobits" || "Megabits" || "Gigabits" || "Terabits" || "Percent" || "Count" || "Bytes/Second" || "Kilobytes/Second" || "Megabytes/Second" || "Gigabytes/Second" || "Terabytes/Second" || "Bits/Second" || "Kilobits/Second" || "Megabits/Second" || "Gigabits/Second" || "Terabits/Second" || "Count/Second" || "None", // required * }; * const command = new GetBucketMetricDataCommand(input); * const response = await client.send(command); * // { // GetBucketMetricDataResult * // metricName: "BucketSizeBytes" || "NumberOfObjects", * // metricData: [ // MetricDatapointList * // { // MetricDatapoint * // average: Number("double"), * // maximum: Number("double"), * // minimum: Number("double"), * // sampleCount: Number("double"), * // sum: Number("double"), * // timestamp: new Date("TIMESTAMP"), * // unit: "Seconds" || "Microseconds" || "Milliseconds" || "Bytes" || "Kilobytes" || "Megabytes" || "Gigabytes" || "Terabytes" || "Bits" || "Kilobits" || "Megabits" || "Gigabits" || "Terabits" || "Percent" || "Count" || "Bytes/Second" || "Kilobytes/Second" || "Megabytes/Second" || "Gigabytes/Second" || "Terabytes/Second" || "Bits/Second" || "Kilobits/Second" || "Megabits/Second" || "Gigabits/Second" || "Terabits/Second" || "Count/Second" || "None", * // }, * // ], * // }; * * ``` * * @param GetBucketMetricDataCommandInput - {@link GetBucketMetricDataCommandInput} * @returns {@link GetBucketMetricDataCommandOutput} * @see {@link GetBucketMetricDataCommandInput} for command's `input` shape. * @see {@link GetBucketMetricDataCommandOutput} for command's `response` shape. * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

Lightsail throws this exception when the user cannot be authenticated or uses invalid * credentials to access a resource.

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

Lightsail throws this exception when user input does not conform to the validation rules * of an input field.

* *

Domain and distribution APIs are only available in the N. Virginia * (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services * Region configuration to us-east-1 to create, view, or edit these * resources.

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

Lightsail throws this exception when it cannot find a resource.

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

Lightsail throws this exception when an operation is performed on resources in an opt-in * Region that is currently being set up.

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

A general service exception.

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

Lightsail throws this exception when the user has not been authenticated.

* * @throws {@link LightsailServiceException} *

Base exception class for all service exceptions from Lightsail service.

* * * @public */ export declare class GetBucketMetricDataCommand extends GetBucketMetricDataCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetBucketMetricDataRequest; output: GetBucketMetricDataResult; }; sdk: { input: GetBucketMetricDataCommandInput; output: GetBucketMetricDataCommandOutput; }; }; }