import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeCacheReportInput, DescribeCacheReportOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeCacheReportCommand}. */ export interface DescribeCacheReportCommandInput extends DescribeCacheReportInput { } /** * @public * * The output of {@link DescribeCacheReportCommand}. */ export interface DescribeCacheReportCommandOutput extends DescribeCacheReportOutput, __MetadataBearer { } declare const DescribeCacheReportCommand_base: { new (input: DescribeCacheReportCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeCacheReportCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns information about the specified cache report, including completion status and * generation progress.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { StorageGatewayClient, DescribeCacheReportCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import * // const { StorageGatewayClient, DescribeCacheReportCommand } = 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 = { // DescribeCacheReportInput * CacheReportARN: "STRING_VALUE", // required * }; * const command = new DescribeCacheReportCommand(input); * const response = await client.send(command); * // { // DescribeCacheReportOutput * // CacheReportInfo: { // CacheReportInfo * // CacheReportARN: "STRING_VALUE", * // CacheReportStatus: "IN_PROGRESS" || "COMPLETED" || "CANCELED" || "FAILED" || "ERROR", * // ReportCompletionPercent: Number("int"), * // EndTime: new Date("TIMESTAMP"), * // Role: "STRING_VALUE", * // FileShareARN: "STRING_VALUE", * // LocationARN: "STRING_VALUE", * // StartTime: new Date("TIMESTAMP"), * // InclusionFilters: [ // CacheReportFilterList * // { // CacheReportFilter * // Name: "UploadState" || "UploadFailureReason", // required * // Values: [ // CacheReportFilterValues // required * // "STRING_VALUE", * // ], * // }, * // ], * // ExclusionFilters: [ * // { * // Name: "UploadState" || "UploadFailureReason", // required * // Values: [ // required * // "STRING_VALUE", * // ], * // }, * // ], * // ReportName: "STRING_VALUE", * // Tags: [ // Tags * // { // Tag * // Key: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // }, * // }; * * ``` * * @param DescribeCacheReportCommandInput - {@link DescribeCacheReportCommandInput} * @returns {@link DescribeCacheReportCommandOutput} * @see {@link DescribeCacheReportCommandInput} for command's `input` shape. * @see {@link DescribeCacheReportCommandOutput} 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.

* * * @public */ export declare class DescribeCacheReportCommand extends DescribeCacheReportCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeCacheReportInput; output: DescribeCacheReportOutput; }; sdk: { input: DescribeCacheReportCommandInput; output: DescribeCacheReportCommandOutput; }; }; }