import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient"; import type { GetInsightRuleReportInput, GetInsightRuleReportOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetInsightRuleReportCommand}. */ export interface GetInsightRuleReportCommandInput extends GetInsightRuleReportInput { } /** * @public * * The output of {@link GetInsightRuleReportCommand}. */ export interface GetInsightRuleReportCommandOutput extends GetInsightRuleReportOutput, __MetadataBearer { } declare const GetInsightRuleReportCommand_base: { new (input: GetInsightRuleReportCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: GetInsightRuleReportCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

This operation returns the time series data collected by a Contributor Insights rule. * The data includes the identity and number of contributors to the log group.

*

You can also optionally return one or more statistics about each data point in the * time series. These statistics can include the following:

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CloudWatchClient, GetInsightRuleReportCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import * // const { CloudWatchClient, GetInsightRuleReportCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import * // import type { CloudWatchClientConfig } from "@aws-sdk/client-cloudwatch"; * const config = {}; // type is CloudWatchClientConfig * const client = new CloudWatchClient(config); * const input = { // GetInsightRuleReportInput * RuleName: "STRING_VALUE", // required * StartTime: new Date("TIMESTAMP"), // required * EndTime: new Date("TIMESTAMP"), // required * Period: Number("int"), // required * MaxContributorCount: Number("int"), * Metrics: [ // InsightRuleMetricList * "STRING_VALUE", * ], * OrderBy: "STRING_VALUE", * }; * const command = new GetInsightRuleReportCommand(input); * const response = await client.send(command); * // { // GetInsightRuleReportOutput * // KeyLabels: [ // InsightRuleContributorKeyLabels * // "STRING_VALUE", * // ], * // AggregationStatistic: "STRING_VALUE", * // AggregateValue: Number("double"), * // ApproximateUniqueCount: Number("long"), * // Contributors: [ // InsightRuleContributors * // { // InsightRuleContributor * // Keys: [ // InsightRuleContributorKeys // required * // "STRING_VALUE", * // ], * // ApproximateAggregateValue: Number("double"), // required * // Datapoints: [ // InsightRuleContributorDatapoints // required * // { // InsightRuleContributorDatapoint * // Timestamp: new Date("TIMESTAMP"), // required * // ApproximateValue: Number("double"), // required * // }, * // ], * // }, * // ], * // MetricDatapoints: [ // InsightRuleMetricDatapoints * // { // InsightRuleMetricDatapoint * // Timestamp: new Date("TIMESTAMP"), // required * // UniqueContributors: Number("double"), * // MaxContributorValue: Number("double"), * // SampleCount: Number("double"), * // Average: Number("double"), * // Sum: Number("double"), * // Minimum: Number("double"), * // Maximum: Number("double"), * // }, * // ], * // }; * * ``` * * @param GetInsightRuleReportCommandInput - {@link GetInsightRuleReportCommandInput} * @returns {@link GetInsightRuleReportCommandOutput} * @see {@link GetInsightRuleReportCommandInput} for command's `input` shape. * @see {@link GetInsightRuleReportCommandOutput} for command's `response` shape. * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. * * @throws {@link InvalidParameterValueException} (client fault) *

The value of an input parameter is bad or out-of-range.

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

An input parameter that is required is missing.

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

The named resource does not exist.

* * @throws {@link CloudWatchServiceException} *

Base exception class for all service exceptions from CloudWatch service.

* * * @public */ export declare class GetInsightRuleReportCommand extends GetInsightRuleReportCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetInsightRuleReportInput; output: GetInsightRuleReportOutput; }; sdk: { input: GetInsightRuleReportCommandInput; output: GetInsightRuleReportCommandOutput; }; }; }